-
Notifications
You must be signed in to change notification settings - Fork 395
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: Remove examples/shim #2484
chore: Remove examples/shim #2484
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You need to add a jsdoc.json
so we can have a page in https://newrelic.github.io/node-newrelic/ that will publish this markdown.
If you run npm run public-docs
this now fails because it's expecting examples/shim
. you can just update the public-docs
script to include documentation/examples.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good over here. npm run public-docs
results in the desired output as far as I can tell.
examples/instrumentation.md
Outdated
@@ -0,0 +1,14 @@ | |||
# node-newrelic examples |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not sure you need this. because when it renders in a tutorial it has a title
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this header is still there
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
found one thing
Co-authored-by: Bob Evans <[email protected]>
Removed the examples/shim folder, added instrumentation.md to redirect users, and updated jsdoc